Skip to content

Boards Menu: add hint if core lives in sketchbook #10007

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Apr 27, 2020
Merged

Boards Menu: add hint if core lives in sketchbook #10007

merged 3 commits into from
Apr 27, 2020

Conversation

facchinm
Copy link
Member

@facchinm facchinm commented Apr 7, 2020

All Submissions:

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?

For core development the recommended methods is to clone the core repo in $sketchbook/hardware. Before 9b48e8d these cores were listed after all Board Manager cores; now they are interleaved and quite difficult to spot immediately.
This patch adds the (sketchbook) label to cores living in sketchbook, using getAbsolutePath so symlinked cores can be spotted too).

@matthijskooijman
Copy link
Collaborator

Sounds like a good change. I've been modifying the platform.txt of these cores to change the label here, doing this automatically would be even better.

But I'm wondering if (sketchbook) is clear to users? I suspect a lot of users do not actually know the term sketchbook. People developing cores likely will, but there might also be people that have just followed some tutorial to install a core into their sketchbook and have no idea.

One alternative that springs to mind would be (manually installed) (as opposed to installed through board manager), but I'm not sure if that's really better (does not help finding the core files if needed).

Or how about (from sketchbook) (or (in sketchbook) or (installed in sketchbook))? That might make it clearer that this refers to the location of the core?

@facchinm
Copy link
Member Author

facchinm commented Apr 7, 2020

(in sketchbook) sounds good, I'm amending the commit 😉

@facchinm facchinm force-pushed the label_core_in_sketchbook branch from 6f5d097 to 4c19878 Compare April 7, 2020 09:01
@matthijskooijman
Copy link
Collaborator

Hm, one more caveat: This now actually checks whether the absolute path is inside the sketchbook, but in my setup all my git checkouts live elsewhere and are symlinked into the sketchbook, so none of them show the (sketchbook) addition...

Would it make sense to, instead of looking at the path, keep a flag (or maybe a "source" field of "install dir/package dir/sketchbook") for each platform that is set when the platforms are loaded?

@facchinm
Copy link
Member Author

facchinm commented Apr 7, 2020

Mine too are symlinked but I can see the label (they didn't show if I replace getAbsolutePath with getCanonicalPath in the subfolder check ). One alternative idea is to show the path (or a substring) if the sources are not in Arduino15 folder, which is unlikely to contain symlinks

@matthijskooijman
Copy link
Collaborator

Mine too are symlinked but I can see the label (they didn't show if I replace getAbsolutePath with getCanonicalPath in the subfolder check ).

Oh, good point. Let me doublecheck my setup and get back to you :-)

@arduino arduino deleted a comment from ArduinoBot Apr 7, 2020
@arduino arduino deleted a comment from ArduinoBot Apr 7, 2020
@ArduinoBot
Copy link
Contributor

✅ Build completed.

Please test this code using one of the following:

⬇️ https://downloads.arduino.cc/javaide/pull_requests/arduino-PR-10007-BUILD-949-linux32.tar.xz
⬇️ https://downloads.arduino.cc/javaide/pull_requests/arduino-PR-10007-BUILD-949-linux64.tar.xz
⬇️ https://downloads.arduino.cc/javaide/pull_requests/arduino-PR-10007-BUILD-949-windows.zip
⬇️ https://downloads.arduino.cc/javaide/pull_requests/arduino-PR-10007-BUILD-949-macosx.zip
⬇️ https://downloads.arduino.cc/javaide/pull_requests/arduino-PR-10007-BUILD-949-linuxarm.tar.xz

ℹ️ The linuxarm build is still experimental and may not be always available.

@cmaglie cmaglie merged commit 156d5d8 into arduino:master Apr 27, 2020
@cmaglie cmaglie added this to the Release 1.8.13 milestone Apr 27, 2020
@matthijskooijman matthijskooijman mentioned this pull request May 12, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@matthijskooijman matthijskooijman matthijskooijman left review comments

@cmaglie cmaglie Awaiting requested review from cmaglie

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
Release 1.8.13
Development

Successfully merging this pull request may close these issues.
4 participants
@facchinm @matthijskooijman @ArduinoBot @cmaglie